Fix lost skip configurations in allof blocks and readOnly and writeOnly in examples#141
Conversation
NickUfer
changed the title
…comes from if there is one
AlexVarchuk
left a comment
AlexVarchuk
left a comment
There was a problem hiding this comment.
Hi @NickUfer . Thank you for your contribution. We appreciate it. 🙌
I think, it is too many changes and too complicated to fix this problem. It looks like a workaround fix. With additional steps to filter all keys 🙈 .
The bug is in the allOf.js file.
We'll get the example value of each item of allOf and merge the result value after it.
Seems this behavior is not correct.
We should resolve allOf to a flat schema and after that generate an example or think about a better solution.
Can you simplify it instead of marking keys for removal?
Also, we should not ignore some example properties from the schema.
It is related to additionalProperties keyword in the schema. They are allowed by default.
|
Simplification is IMO not possible because the architecture of the sampler project is flawed. Crucial information about properties is lost in the process and IMO a rewrite is necessary to fix this, which includes keeping as much information as possible until the final merging of a single object. That's why I decided to write this fix, even if it is not exactly the perfect solution. About the |
2 participants
What/Why/How?
The sampler ignores readOnly and writeOnly on properties in allOf's and in examples.
The problem with allOf's is that the readOnly and writeOnly information of properties is lost in them. This PR preserves the information by marking the properties with a special object
MARKED_FOR_REMOVALwhich were supposed to be removed byskipNonRequired=true,skipReadOnly=trueorskipWriteOnly=true. Before the result is returned all values which are supposed to be removed are removed.The problem with having example values in the sample even if they are readOnly or writeOnly is fixed by traversing the schema again for which the example is intended and removing all values which are invalid from the example.
Reference
Fixes #140
Fixes Redocly/redoc#1238
Testing
Tests for the changes were added.
Screenshots (optional)
Check yourself
Security